Get Script Templates
The Get Script Templates request retrieves a list of script templates.
HTTP Method
GET
URI
Copy
{{baseUrl}}/api/v2/scripttemplates?skip=0&take=100&scriptType=Sbc
Request Parameters
|
Parameter |
Type |
Description |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
Page Number |
Integer Default value : 0 |
Page number in range to retrieve. |
|||||||||
|
Page Size |
Integer, Default value: 10 |
Number of pages in range to retrieve. |
|||||||||
|
scriptType |
String (query) |
One of the following categories:
|
Example Response
Copy
[
{
"id": 100,
"customerVariables": null,
"name": "sbc-add-prefix",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 101,
"customerVariables": null,
"name": "sbc-remove-prefix",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 103,
"customerVariables": null,
"name": "add-ip-pbx-user",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 700,
"customerVariables": null,
"name": "sbc-scenario7Cleanup",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 1090,
"value": "Avaya Esessntial"
}
]
},
{
"id": 1010,
"customerVariables": null,
"name": "SIP trunk Hawaii",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 1020,
"value": "SIP Trunk Hawaii Clean"
}
]
},
{
"id": 1020,
"customerVariables": null,
"name": "SIP Trunk Hawaii Clean",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 1010,
"value": "SIP trunk Hawaii"
}
]
},
{
"id": 1030,
"customerVariables": "IPPBX-proxyaddress,IPPBX-proxyaddress-SIPPort,SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.IPPBX-proxyaddress-SIPPort, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.IPPBX-proxyaddress-SIPPort, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.SIP-Hostname",
"name": "IPPBX",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 1040,
"value": "IPPBX Clean"
}
]
},
{
"id": 1040,
"customerVariables": "",
"name": "IPPBX Clean",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 1030,
"value": "IPPBX"
}
]
},
{
"id": 1050,
"customerVariables": "OnlinePstnGateway,CustomerName",
"name": "Add a2nd SIP trunk Hawaii",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 1060,
"value": "Clean Add site"
}
]
},
{
"id": 1060,
"customerVariables": null,
"name": "Clean Add site",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 1050,
"value": "Add a2nd SIP trunk Hawaii"
},
{
"key": 1080,
"value": "Add SIP Trunk Cellcom"
}
]
},
{
"id": 1080,
"customerVariables": "OnlinePstnGateway,CustomerName",
"name": "Add SIP Trunk Cellcom",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 1060,
"value": "Clean Add site"
}
]
},
{
"id": 1090,
"customerVariables": null,
"name": "Avaya Esessntial",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 700,
"value": "sbc-scenario7Cleanup"
}
]
},
{
"id": 2000,
"customerVariables": "ITSP_IPAddress,ITSP_SIPPort,ITSP_TransportType_UDP-TCP-TLS,ITSP_MediaSecurity_Secure-Unsecure\r\n",
"name": "Sandbox TeamsDR-Add Customer with ITSP",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 2001,
"value": "Sandbox TeamsDR-Remove Customer with ITSP"
}
]
},
{
"id": 2001,
"customerVariables": null,
"name": "Sandbox TeamsDR-Remove Customer with ITSP",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 2002,
"value": "Sandbox TeamsDR-Add Site with ITSP"
},
{
"key": 2000,
"value": "Sandbox TeamsDR-Add Customer with ITSP"
}
]
},
{
"id": 2002,
"customerVariables": "ITSP_IPAddress,ITSP_SIPPort,ITSP_TransportType_UDP-TCP-TLS,ITSP_MediaSecurity_Secure-Unsecure\r\n",
"name": "Sandbox TeamsDR-Add Site with ITSP",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 2001,
"value": "Sandbox TeamsDR-Remove Customer with ITSP"
}
]
},
{
"id": 2003,
"customerVariables": "Device_IPAddress,Device_SIPPort,Device_TransportType_UDP-TCP-TLS,Device_MediaSecurity_Secure-Unsecure\r\n\r\n",
"name": "Sandbox TeamsDR-Add Customer Device",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 2004,
"value": "Sandbox TeamsDR-Remove Customer Device"
}
]
},
{
"id": 2004,
"customerVariables": null,
"name": "Sandbox TeamsDR-Remove Customer Device",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 2003,
"value": "Sandbox TeamsDR-Add Customer Device"
}
]
},
{
"id": 2005,
"customerVariables": "MP-username,MP-password,MP-IpAddress,MP-MediaSecurity_Secure-Unsecure,OrigCustomer",
"name": "Sandbox Add MediaPack with Registration",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 2006,
"value": "Sandbox Remove MediaPack with Registration"
}
]
},
{
"id": 2006,
"customerVariables": null,
"name": "Sandbox Remove MediaPack with Registration",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 2005,
"value": "Sandbox Add MediaPack with Registration"
}
]
},
{
"id": 2007,
"customerVariables": "Carrier-ProxyAddress,Carrier-SIPPort,Carrier-TransportType_UDP-TCP-TLS,Carrier-MediaSecurity_Secure-Unsecure",
"name": "Sandbox Add OC BYOC Customer",
"scriptTemplateType": 5,
"description": null,
"relatedScripts": [
{
"key": 2008,
"value": "Sandbox Remove OC BYOC Customer"
}
]
},
{
"id": 2008,
"customerVariables": null,
"name": "Sandbox Remove OC BYOC Customer",
"scriptTemplateType": 6,
"description": null,
"relatedScripts": [
{
"key": 2007,
"value": "Sandbox Add OC BYOC Customer"
},
{
"key": 2009,
"value": "Sandbox Add OC BYOC Customer with SIP Group Name"
}
]
},
{
"id": 2009,
"customerVariables": "Carrier-ProxyAddress,Carrier-SIPPort,Carrier-TransportType_UDP-TCP-TLS,Carrier-MediaSecurity_Secure-Unsecure,Carrier-SIPGroupName",
"name": "Sandbox Add OC BYOC Customer with SIP Group Name",
"scriptTemplateType": 5,
"description": null,
"relatedScripts": [
{
"key": 2008,
"value": "Sandbox Remove OC BYOC Customer"
}
]
},
{
"id": 5000,
"customerVariables": null,
"name": "sbc-add-oc-numbers",
"scriptTemplateType": 8,
"description": null,
"relatedScripts": [
{
"key": 5001,
"value": "sbc-remove-oc-numbers"
}
]
},
{
"id": 5001,
"customerVariables": null,
"name": "sbc-remove-oc-numbers",
"scriptTemplateType": 9,
"description": null,
"relatedScripts": [
{
"key": 5000,
"value": "sbc-add-oc-numbers"
},
{
"key": 5461216,
"value": "sbc-add-oc-numbers-ipgroup-type"
}
]
},
{
"id": 6000,
"customerVariables": null,
"name": "create-app-registration",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 10007,
"customerVariables": "CustomVar.IPPBX-proxyaddress, CustomVar.IPPBX-proxyaddress-SIPPort, , , , ",
"name": "old_sbc-scenario7",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 10700,
"value": "old_sbc-scenario7Cleanup"
}
]
},
{
"id": 10100,
"customerVariables": null,
"name": "old_sbc-add-prefix",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 10101,
"customerVariables": null,
"name": "old_sbc-remove-prefix",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 10103,
"customerVariables": null,
"name": "old_add-ip-pbx-user",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 10700,
"customerVariables": "",
"name": "old_sbc-scenario7Cleanup",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 10007,
"value": "old_sbc-scenario7"
}
]
},
{
"id": 100103,
"customerVariables": null,
"name": "old_add-ip-pbx-user",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 999123,
"customerVariables": "MsTenantId",
"name": "WSC test",
"scriptTemplateType": 5,
"description": null,
"relatedScripts": [
{
"key": 5461215,
"value": "OcEssential default SBC cleanup script"
}
]
},
{
"id": 5461210,
"customerVariables": null,
"name": "M365 default onboarding",
"scriptTemplateType": 3,
"description": null,
"relatedScripts": [
{
"key": 5461211,
"value": "M365 default cleanup"
}
]
},
{
"id": 5461211,
"customerVariables": null,
"name": "M365 default cleanup",
"scriptTemplateType": 4,
"description": null,
"relatedScripts": [
{
"key": 5461210,
"value": "M365 default onboarding"
},
{
"key": 5461212,
"value": "M365 onboarding with Location Based Routing"
},
{
"key": 5461213,
"value": "M365 onboarding with LBR and custom networks"
},
{
"key": 5461220,
"value": "M365 default onboarding using SBC Site name"
}
]
},
{
"id": 5461212,
"customerVariables": null,
"name": "M365 onboarding with Location Based Routing",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 5461213,
"customerVariables": "IP-Network,IP-SubnetBits,Trusted-IP-Network,Trusted-IP-SubnetBits",
"name": "M365 onboarding with LBR and custom networks",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 5461214,
"customerVariables": null,
"name": "OcEssential default SBC onboarding script",
"scriptTemplateType": 5,
"description": null,
"relatedScripts": [
{
"key": 5461215,
"value": "OcEssential default SBC cleanup script"
}
]
},
{
"id": 5461215,
"customerVariables": null,
"name": "OcEssential default SBC cleanup script",
"scriptTemplateType": 6,
"description": null,
"relatedScripts": [
{
"key": 999123,
"value": "WSC test"
},
{
"key": 5461214,
"value": "OcEssential default SBC onboarding script"
}
]
},
{
"id": 5461216,
"customerVariables": null,
"name": "sbc-add-oc-numbers-ipgroup-type",
"scriptTemplateType": 8,
"description": null,
"relatedScripts": [
{
"key": 5001,
"value": "sbc-remove-oc-numbers"
}
]
},
{
"id": 5461217,
"customerVariables": null,
"name": "M365 OnlinePstnGateway Remove",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 5461218,
"customerVariables": null,
"name": "task-configure-pstnGateway",
"scriptTemplateType": 0,
"description": null,
"relatedScripts": null
},
{
"id": 5461219,
"customerVariables": null,
"name": "arm-cleanup",
"scriptTemplateType": 7,
"description": null,
"relatedScripts": null
},
{
"id": 5461220,
"customerVariables": null,
"name": "M365 default onboarding using SBC Site name",
"scriptTemplateType": 3,
"description": null,
"relatedScripts": [
{
"key": 5461211,
"value": "M365 default cleanup"
}
]
},
{
"id": 5461221,
"customerVariables": "ITSP_IPAddress,ITSP_SIPPort,ITSP_TransportType_UDP-TCP-TLS,ITSP_MediaSecurity_Secure-Unsecure\r\n",
"name": "TeamsDR-Add customer with ITSP",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 5461222,
"value": "TeamsDR-Remove customer with ITSP "
}
]
},
{
"id": 5461222,
"customerVariables": "",
"name": "TeamsDR-Remove customer with ITSP ",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 5461221,
"value": "TeamsDR-Add customer with ITSP"
},
{
"key": 5461223,
"value": "TeamsDR-Add Site with ITSP "
}
]
},
{
"id": 5461223,
"customerVariables": "ITSP_IPAddress,ITSP_SIPPort,ITSP_TransportType_UDP-TCP-TLS,ITSP_MediaSecurity_Secure-Unsecure\r\n",
"name": "TeamsDR-Add Site with ITSP ",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 5461222,
"value": "TeamsDR-Remove customer with ITSP "
}
]
},
{
"id": 5461224,
"customerVariables": "Device_IPAddress,Device_SIPPort,Device_TransportType_UDP-TCP-TLS,Device_MediaSecurity_Secure-Unsecure\r\n\r\n",
"name": "TeamsDR-Add Customer Device",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 5461225,
"value": "TeamsDR-Remove Customer Device"
}
]
},
{
"id": 5461225,
"customerVariables": "",
"name": "TeamsDR-Remove Customer Device",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 5461224,
"value": "TeamsDR-Add Customer Device"
}
]
},
{
"id": 5461226,
"customerVariables": null,
"name": "OcSbcOnboarding",
"scriptTemplateType": 5,
"description": null,
"relatedScripts": [
{
"key": 5461227,
"value": "OcSbcCleanup"
}
]
},
{
"id": 5461227,
"customerVariables": null,
"name": "OcSbcCleanup",
"scriptTemplateType": 6,
"description": null,
"relatedScripts": [
{
"key": 5461226,
"value": "OcSbcOnboarding"
}
]
},
{
"id": 5461228,
"customerVariables": "Carrier-ProxyAddress,Carrier-SIPPort\r\n,Carrier-TransportType_UDP-TCP-TLS\r\n,Carrier-MediaSecurity_Secure-Unsecure",
"name": "Add OC BYOC Customer",
"scriptTemplateType": 5,
"description": null,
"relatedScripts": [
{
"key": 5461229,
"value": "Remove OC BYOC Customer"
}
]
},
{
"id": 5461229,
"customerVariables": null,
"name": "Remove OC BYOC Customer",
"scriptTemplateType": 6,
"description": null,
"relatedScripts": [
{
"key": 5461228,
"value": "Add OC BYOC Customer"
}
]
},
{
"id": 5461230,
"customerVariables": "MP-username,MP-password,MP-IpAddress,MP-MediaSecurity_Secure-Unsecure,OrigCustomer",
"name": "Add MediaPack with Registration",
"scriptTemplateType": 1,
"description": null,
"relatedScripts": [
{
"key": 5461231,
"value": "Remove MediaPack with Registration "
}
]
},
{
"id": 5461231,
"customerVariables": null,
"name": "Remove MediaPack with Registration ",
"scriptTemplateType": 2,
"description": null,
"relatedScripts": [
{
"key": 5461230,
"value": "Add MediaPack with Registration"
}
]
},
{
"id": 5461232,
"customerVariables": "CustomVar.IPPBX-proxyaddress, CustomVar.IPPBX-proxyaddress-SIPPort, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.IPPBX-proxyaddress-SIPPort, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.IPPBX-proxyaddress-SIPPort, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.IPPBX-proxyaddress-SIPPort, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.SIP-Hostname, , CustomVar.IPPBX-proxyaddress, CustomVar.IPPBX-proxyaddress-SIPPort, CustomVar.SIP-Hostname, CustomVar.IPPBX-proxyaddress, CustomVar.SIP-Hostname",
"name": "BradTest",
"scriptTemplateType": 1,
"description": "Brad Test with custom variables",
"relatedScripts": []
},
{
"id": 5461233,
"customerVariables": "",
"name": "BradScriptCleanup",
"scriptTemplateType": 2,
"description": "BradCleanup",
"relatedScripts": []
}
]HTTP Responses
| ■ | 200 OK |
|
Attribute |
Type |
Description |
|||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
id |
Integer |
The unique id of the script. See SBC Template Scenarios for references to IDs for default SBC script templates. See M365 Template Scenarios for references to IDs for default M365 script templates. |
|||||||||||||||||||||||||||
|
customerVariables |
String |
Customer defined variables, mandatory for the script execution. Corresponds to the "CustomerVariables" column in the database record. Its recommended not to define like variable1, variable2 and instead to use meaningful names e.g. localhostname. See SBC Template Scenarios for references to customer variables for default SBC script templates. See M365 Template Scenarios for references to customer variables for default M365 script templates. |
|||||||||||||||||||||||||||
|
name |
String |
Corresponds to the "Friendly Name" of the script column in the database record. For example, "sbc-scenario7". |
|||||||||||||||||||||||||||
|
scriptTemplateType |
Integer |
Specifies the type of action applied by the script. One of the following values:
See SBC Template Scenarios for references to customer variables for default SBC script templates. See M365 Template Scenarios for references to customer variables for default M365 script templates. |
|||||||||||||||||||||||||||
|
description |
String |
Corresponds to the "Description" column in the script record. |
|||||||||||||||||||||||||||
|
relatedScripts |
List array key: integer value: string
|
The database id (key) and name of the related script. For example, script id '5000' with value 'sbc-add-oc-numbershas the related script id '5001' with value 'sbc-remove-oc-numbers'. |